pyglet.text.HTMLLabel

init

(Constructor) __init__(self, text='', location=None, x=0, y=0, width=None, height=None, anchor_x='left', anchor_y='baseline', multiline=False, dpi=None, batch=None, group=None)

Create a label with an HTML string.

Parameters:

text : str: HTML formatted text to display.
location : Location: Location object for loading images referred to in the document. By default, the working directory is used.
x : int: X coordinate of the label.
y : int: Y coordinate of the label.
width : int: Width of the label in pixels, or None
height : int: Height of the label in pixels, or None
anchor_x : str: Anchor point of the X coordinate: one of "left", "center" or "right".
anchor_y : str: Anchor point of the Y coordinate: one of "bottom", "baseline", "center" or "top".
multiline : bool: If True, the label will be word-wrapped and render paragraph and line breaks. You must also set the width of the label.
dpi : float: Resolution of the fonts in this layout. Defaults to 96.
batch : Batch: Optional graphics batch to add the label to.
group : Group: Optional graphics group to use.

Overrides:

DocumentLabel.__init__

	__init__(self, text=`''`, location=None, x=0, y=0, width=None, height=None, anchor_x=`'left'`, anchor_y=`'baseline'`, multiline=False, dpi=None, batch=None, group=None) Create a label with an HTML string.
	begin_update(self) Indicate that a number of changes to the layout or document are about to occur. (Inherited from pyglet.text.layout.TextLayout)
	delete(self) Remove this layout from its batch. (Inherited from pyglet.text.layout.TextLayout)
	draw(self) Draw this text layout. (Inherited from pyglet.text.layout.TextLayout)
	end_update(self) Perform pending layout changes since begin_update. (Inherited from pyglet.text.layout.TextLayout)
object	get_style(self, name) Get a document style value by name. (Inherited from pyglet.text.DocumentLabel)
	on_delete_text(self, start, end) Event handler for `AbstractDocument.on_delete_text`. (Inherited from pyglet.text.layout.TextLayout)
	on_insert_text(self, start, text) Event handler for `AbstractDocument.on_insert_text`. (Inherited from pyglet.text.layout.TextLayout)
	on_style_text(self, start, end, attributes) Event handler for `AbstractDocument.on_style_text`. (Inherited from pyglet.text.layout.TextLayout)
	set_style(self, name, value) Set a document style value by name over the whole document. (Inherited from pyglet.text.DocumentLabel)

str	text HTML formatted text of the label.
str	anchor_x Horizontal anchor alignment. (Inherited from pyglet.text.layout.TextLayout)
str	anchor_y Vertical anchor alignment. (Inherited from pyglet.text.layout.TextLayout)
bool	bold Bold font style. (Inherited from pyglet.text.DocumentLabel)
(int, int, int, int)	color Text color. (Inherited from pyglet.text.DocumentLabel)
str	content_valign Vertical alignment of content within larger layout box. (Inherited from pyglet.text.layout.TextLayout)
	document (Inherited from pyglet.text.layout.TextLayout)
float	dpi Get DPI used by this layout. (Inherited from pyglet.text.layout.TextLayout)
str or list	font_name Font family name. (Inherited from pyglet.text.DocumentLabel)
float	font_size Font size, in points. (Inherited from pyglet.text.DocumentLabel)
int	height Height of the layout. (Inherited from pyglet.text.layout.TextLayout)
bool	italic Italic font style. (Inherited from pyglet.text.DocumentLabel)
bool	multiline Set if multiline layout is enabled. (Inherited from pyglet.text.layout.TextLayout)
int	width Width of the layout. (Inherited from pyglet.text.layout.TextLayout)
int	x X coordinate of the layout. (Inherited from pyglet.text.layout.TextLayout)
int	y Y coordinate of the layout. (Inherited from pyglet.text.layout.TextLayout)

Class pyglet.text.HTMLLabel

Methods

Properties

Instance Variables

Method Details

init

Property Details

text

Group	background_group = `OrderedGroup(0)` Rendering group for background color. (Inherited from pyglet.text.layout.TextLayout)
int	content_height Calculated height of the text in the layout. (Inherited from pyglet.text.layout.TextLayout)
int	content_width Calculated width of the text in the layout. (Inherited from pyglet.text.layout.TextLayout)
Group	foreground_decoration_group = `TextLayoutForegroundDecorationGr...` Rendering group for glyph underlines. (Inherited from pyglet.text.layout.TextLayout)
Group	foreground_group = `TextLayoutForegroundGroup(1)` Rendering group for glyphs. (Inherited from pyglet.text.layout.TextLayout)
Group	top_group = `<pyglet.text.layout.TextLayoutGroup object at 0xfa...` Top-level rendering group. (Inherited from pyglet.text.layout.TextLayout)